Tacho API

 

Tacho API is available to enable integrated users to remote download tachograph files captured within REVEAL from the digital tachograph device

Important concepts to understand prior to utilizing any of the available integration methods:

·      Tacho API is offered as a RESTful web service

·      Standard REST verbs are applied: GET

·      Throughout this document, we will reference the unique identifier to be invoked for each of the main objects available to be created or deleted.  The unique identifiers used within this API method set include:

o   Vehicle number

o   Driver card number

o   File ID

Note: The current version of the Tacho API does not support devices tracking Non-Powered Assets.  No information will return regarding Non-Powered Assets within any of the following API methods.

 

API Summary Details

API Name

Tacho API

Endpoint

https://fim.api.eu.fleetmatics.com/rad

Operation

GET

 

Get files

The following methods enable integrated users to remote download a vehicle’s or driver’s tachograph files from REVEAL. These methods can be only called for one Vehicle/ Driver or file

 

GET Tachograph drivers

The GET tachograph driver method provides integration users with the ability to retrieve drivers with a tachograph card number within a fleet at a regular interval

 

GET tachograph drivers Request Header

Operation and Path

GET

HOST

fim.api.eu.fleetmatics.com

Accept

application/json

Authorization

Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token>

Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

 

GET tachograph driver sample response

{
       
      "driverCardNumber": "0054114637021088",
      "firstname": "Chris",
      "lastname": "Abernathy "
    },
    {
  
      "driverCardNumber": "00706857089993",
      "firstName": "TachoDriver",
      " lastname ": "ODQZMAGRWFZWLRO"
    }
  ],
  "

 

 

GET Location Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

First Name

        "FirstName": "Chris",

The first name of the driver.

Last Name

        "LastName": "Abernathy",

The last name of the driver.

Driver card number

         “0054114637021088”

The Driver Tachograph card number

 

GET Vehicle Tachograph Files List

The vehicle my tachograph files list by vehicle number returns vehicle file IDs for a specified time range

 

GET vehicle tachograph file list Request Header

Operation and Path

GET

HOST

fim.api.eu.fleetmatics.com

Accept

application/json

Authorization

Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token>

Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

 

GET vehicle tachograph file list Response

[
  {
    "vehicleName": "TachoEnabled Simulator",
    "fileId": 7008,
    "lastDownloadDateTime": "2021-02-18T11:04:00"
  },
  {
    "vehicleName": "TachoEnabled",
    "fileId": 7026,
    "lastDownloadDateTime": "2021-01-15T10:12:00"
  }
]

 

 

GET vehicle tachograph file list Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Vehicle Number

"VehicleNumber":"TachoEnabled Simulator ",

The Vehicle Name as recorded within the REVEAL vehicle profile.

File ID

5

This is a unique identifier associated with that specific driver file

Last download date

" Last download date Utc": "2021-03-23T18:12:47.661Z "

 

The date and time when the file was last downloaded to the referenced vehicle Number.

 

GET Driver Tachograph Files List

The vehicle my tachograph files list by Driver tachograph card  number returns driver file IDs for a specified time range

 

GET driver tachograph file list Request Header

Operation and Path

GET

HOST

fim.api.eu.fleetmatics.com

Accept

application/json

Authorization

Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token>

Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

 

GET driver tachograph file list Response


[
  {
    "firstName": "
Chris ",
    "lastName": "
Abernathy ",
    "fileId": 17097,
    "lastDownloadDateTime": "2021-03-18T11:39:00"
  },
  {
    "firstName": "TachoDriver",
    "lastName": "WYIMISVSSDNXRQT",
    "fileId": 17094,
    "lastDownloadDateTime": "2021-03-16T11:39:00"
  },
  {
    "firstName": "TachoDriver1",
    "lastName": "WYIMISVSYYUIE",
    "fileId": 17096,
    "lastDownloadDateTime": "2021-03-15T11:39:00"
  },  
]

 

 

GET driver tachograph file list Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

First Name

   "FirstName": "Chris",

The first name of the driver.

Last Name

    "LastName": "Abernathy",

The last name of the driver.

File ID

     17097

This is a unique identifier associated with that specific driver file

Last download date

" Last download date Utc": "2021-03-18T11:39:00"

 

The date and time when the file was last downloaded to the referenced driver card  Number.

 

GET Tachograph file content

The tachograph file ,returns the actual tachograph file for the specified file ID

 

GET tachograph  file content Request Header

Operation and Path

GET

HOST

fim.api.eu.fleetmatics.com

Accept

application/json

Authorization

Atmosphere realm=http://atmosphere,atmosphere_app_id=<Integration Manager App ID>, Bearer <token>

Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

 

GET tachograph file content Response

{

  "fileContent": "MS4wMDAxMjMsIDEuMDAwMTIzLCAxLjAwMDEyMywgMS"

}

 

GET vehicle tachograph file content Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Filecontent

“MS4wMDAxMjMsIDEuMDAwMTIzLCAxLjAwMDEyMywgMS”    

 This is a base 64 encoded file

Note -

The Status will be:

200 – Successful OK­

404- Resource not found 

401 - User not authorized 

400- Bad request ( Date range) 

500 - System error